/**
 * Copyright (c) 2010 BullionXpress.com,
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

package com.bullionxpress.shared.model;

import java.io.Serializable;

/**
 *
 * @author BullionXpress.com
 */
public class Instrument implements Serializable {

    private String symbol;
    //private String name;
    private String description;

    private Instrument()
    {
        //this("GOLD");
    }

    

    public boolean equals(Instrument other)
    {
        if( this.getSymbol().equals(other.getSymbol())){
            return true;
        }
        return false;
    }

    public Instrument(String name)
    {
        //this.name = name;
        setSymbol(name);
    }

    public String toString()
    {
        return symbol;
    }


    /**
     * @return the description
     */
    public String getDescription() {
        return description;
    }

    /**
     * @param description the description to set
     */
    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * @return the id
     */
    public String getSymbol() {
        return symbol;
    }

    /**
     * @param id the id to set
     */
    public void setSymbol(String id) {
        if( id == null ){ throw new IllegalArgumentException("Symbol ID cannot be null"); }
        this.symbol = id.toUpperCase();
    }
}
